package com.study.hive.udtf;

import org.apache.hadoop.hive.ql.exec.UDFArgumentException;
import org.apache.hadoop.hive.ql.metadata.HiveException;
import org.apache.hadoop.hive.ql.udf.generic.GenericUDTF;
import org.apache.hadoop.hive.serde2.objectinspector.ObjectInspector;
import org.apache.hadoop.hive.serde2.objectinspector.ObjectInspectorFactory;
import org.apache.hadoop.hive.serde2.objectinspector.StructObjectInspector;
import org.apache.hadoop.hive.serde2.objectinspector.primitive.PrimitiveObjectInspectorFactory;

import java.util.ArrayList;
import java.util.List;

/**
 * UDTF（User-Defined Table-Generating Functions）用来解决 输入一行输出多行（On-to-many maping） 的需求。
 *
 * 限制：
 *         1、No other expressions are allowed in SELECT 不能和其他字段一起使用
 *                 SELECT pageid, explode(adid_list) AS myCol... is not supported
 *         2、UDTF's can't be nested 不能嵌套
 *                 SELECT explode(explode(adid_list)) AS myCol... is not supported
 *         3、GROUP BY / CLUSTER BY / DISTRIBUTE BY / SORT BY is not supported
 *                 SELECT explode(adid_list) AS myCol ... GROUP BY myCol is not supported
 *
 * 继承 org.apache.hadoop.hive.ql.udf.generic.GenericUDTF ，实现 initialize,  process,  close 三个方法。
 *
 * 执行过程：
 *
 *     1、UDTF首先会调用 initialize 方法，此方法返回UDTF的输出行的信息（输出列个数与类型）
 *     2、初始化完成后，会调用 process 方法，真正的处理过程在process函数中：
 *         在process中，每一次 forward() 调用产生一行；
 *         如果产生多列可以将多个列的值放在一个数组中，然后将该数组传入到 forward() 函数。
 *     3、 最后 close() 方法调用，对需要清理的方法进行清理。
 *
 * hive (default)> add jar /opt/module/data/udtf.jar;
 * hive (default)> create temporary function myudtf as "com.study.hive.udtf.MyUDTF";
 * hive (default)> select myudtf(line, ",") word from words;
 * hive (default)> select id, myudtf(line, ",") word from words; 不能这样
 * hive (default)> select word from words lateral view myudtf(line, ",") w as word;
 *
 * @author stephen
 * @date 2019-09-06 17:09
 */
public class MyUDTF extends GenericUDTF {

    private ArrayList<String> outList = new ArrayList<>();

    @Override
    public StructObjectInspector initialize(StructObjectInspector argOIs) throws UDFArgumentException {
        //1.定义输出数据的列名和类型
        List<String> fieldNames = new ArrayList<>();
        List<ObjectInspector> fieldOIs = new ArrayList<>();
        //2.添加输出数据的列名和类型
        fieldNames.add("word");
        fieldOIs.add(PrimitiveObjectInspectorFactory.javaStringObjectInspector);
        return ObjectInspectorFactory.getStandardStructObjectInspector(fieldNames, fieldOIs);
    }

    @Override
    public void process(Object[] args) throws HiveException {
        //1.获取传入的第一个参数，原始数据
        String arg = args[0].toString();
        //2.获取传入的第二个参数，分隔符
        String splitKey = args[1].toString();
        //3.将原始数据按照传入的分隔符进行切分
        String[] fields = arg.split(splitKey);
        //4.遍历切分后的结果，并写出
        for (String field : fields) {
            //集合为复用的，首先清空集合
            outList.clear();
            //将每一个单词添加至集合
            outList.add(field);
            //将集合内容写出
            forward(outList);
        }
    }

    @Override
    public void close() throws HiveException {

    }
}
